<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.forwardingRules.html">forwardingRules</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of forwarding rules.</p>
<p class="toc_element">
  <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#delete">delete(project, region, forwardingRule, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified ForwardingRule resource.</p>
<p class="toc_element">
  <code><a href="#get">get(project, region, forwardingRule, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the specified ForwardingRule resource.</p>
<p class="toc_element">
  <code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a ForwardingRule resource in the specified project and region using</p>
<p class="toc_element">
  <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of ForwardingRule resources available to the specified</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(project, region, forwardingRule, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified forwarding rule with the data included in the</p>
<p class="toc_element">
  <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the labels on the specified resource. To learn more about labels,</p>
<p class="toc_element">
  <code><a href="#setTarget">setTarget(project, region, forwardingRule, body=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Changes target URL for forwarding rule. The new target should be of the</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
  <pre>Retrieves an aggregated list of forwarding rules.

To prevent failure, it is recommended that you set the
`returnPartialSuccess` parameter to `true`.

Args:
  project: string, Project ID for this request. (required)
  filter: string, A filter expression that filters resources listed in the response. Most
Compute resources support two types of filter expressions:
expressions that support regular expressions and expressions that follow
API improvement proposal AIP-160.
These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The operator
must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.

For example, if you are filtering Compute Engine instances, you can
exclude instances named `example-instance` by specifying
`name != example-instance`.

The `:*` comparison can be used to test whether a key has been defined.
For example, to find all objects with `owner` label use:
```
labels.owner:*
```

You can also filter nested fields. For example, you could specify
`scheduling.automaticRestart = false` to include instances only
if they are not scheduled for automatic restarts. You can use filtering
on nested fields to filter based onresource labels.

To filter on multiple expressions, provide each separate expression within
parentheses. For example:
```
(scheduling.automaticRestart = true)
(cpuPlatform = &quot;Intel Skylake&quot;)
```
By default, each expression is an `AND` expression. However, you
can include `AND` and `OR` expressions explicitly.
For example:
```
(cpuPlatform = &quot;Intel Skylake&quot;) OR
(cpuPlatform = &quot;Intel Broadwell&quot;) AND
(scheduling.automaticRestart = true)
```

If you want to use a regular expression, use the `eq` (equal) or `ne`
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:

`fieldname eq unquoted literal`
`fieldname eq &#x27;single quoted literal&#x27;`
`fieldname eq &quot;double quoted literal&quot;`
`(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`

The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.

For example, to filter for instances that do not end with name &quot;instance&quot;,
you would use `name ne .*instance`.

You cannot combine constraints on multiple fields using regular
expressions.
  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
global) should be included in the response. For new resource types added
after this field, the flag has no effect as new resource types will always
include every visible scope for each scope type in response. For resource
types which predate this field, if this flag is omitted or false, only
scopes of the scope types where the resource type is expected to be found
will be included.
  maxResults: integer, The maximum number of results per page that should be returned.
If the number of available results is larger than `maxResults`,
Compute Engine returns a `nextPageToken` that can be used to get
the next page of results in subsequent list requests. Acceptable values are
`0` to `500`, inclusive. (Default: `500`)
  orderBy: string, Sorts list results by a certain order. By default, results
are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation
timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
results based on the `creationTimestamp` field in
reverse chronological order (newest result first). Use this to sort
resources like operations so that the newest operation is returned first.

Currently, only sorting by `name` or
`creationTimestamp desc` is supported.
  pageToken: string, Specifies a page token to use. Set `pageToken` to the
`nextPageToken` returned by a previous list request to get
the next page of results.
  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a
single zone scope either returns all resources in the zone or no resources,
with an error code.
  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
aggregated list request is invoked for subnetworks list-usable api.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
  &quot;items&quot;: { # A list of ForwardingRulesScopedList resources.
    &quot;a_key&quot;: { # Name of the scope containing this set of addresses.
      &quot;forwardingRules&quot;: [ # A list of forwarding rules contained in this scope.
        { # Represents a Forwarding Rule resource.
            #
            # Forwarding rule resources in Google Cloud can be either regional or global in
            # scope:
            #
            # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
            # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
            #
            # A forwarding rule and its corresponding IP address represent the frontend
            # configuration of a Google Cloud load balancer.
            # Forwarding rules can also reference target instances and Cloud VPN Classic
            # gateways (targetVpnGateway).
            #
            # For more information, read
            # Forwarding rule concepts and
            # Using protocol forwarding.
          &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
              # sends traffic to this IP address, the forwarding rule directs the traffic
              # to the referenced target or backendService.
              # While creating a forwarding rule, specifying an IPAddress is
              # required under the following circumstances:
              #
              #
              #    - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
              #    - When the target is a Private Service Connect Google APIs
              #    bundle, you must specify an IPAddress.
              #
              #
              # Otherwise, you can optionally specify an IP address that references an
              # existing static (reserved) IP address resource. When omitted, Google Cloud
              # assigns an ephemeral IP address.
              #
              # Use one of the following formats to specify an IP address while creating a
              # forwarding rule:
              #
              # * IP address number, as in `100.1.2.3`
              # * IPv6 address range, as in `2600:1234::/96`
              # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
              # * Partial URL or by name, as in:
              #
              #    - projects/project_id/regions/region/addresses/address-name
              #    - regions/region/addresses/address-name
              #    - global/addresses/address-name
              #    - address-name
              #
              #
              #
              # The forwarding rule&#x27;s target or backendService,
              # and in most cases, also the loadBalancingScheme, determine the
              # type of IP address that you can use. For detailed information, see
              # [IP address
              # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
              #
              # When reading an IPAddress, the API always returns the IP
              # address number.
          &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
              #
              # For protocol forwarding, valid
              # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
              #
              # The valid IP protocols are different for different load balancing products
              # as described in [Load balancing
              # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
          &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
              # fields are mutually exclusive. Only packets addressed to ports in the
              # specified range will be forwarded to the backends configured with this
              # forwarding rule.
              #
              # The allPorts field has the following limitations:
              #
              #    - It requires that the forwarding rule IPProtocol be TCP,
              #    UDP, SCTP, or L3_DEFAULT.
              #    - It&#x27;s applicable only to the following products: internal passthrough
              #    Network Load Balancers, backend service-based external passthrough Network
              #    Load Balancers, and internal and external protocol forwarding.
              #    - Set this field to true to allow packets addressed to any port or
              #    packets lacking destination port information (for example, UDP fragments
              #    after the first fragment) to be forwarded to the backends configured with
              #    this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
          &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
              # Balancers, the regional internal Application Load Balancer, and the
              # regional internal proxy Network Load Balancer from all regions.
              # If false, only allows access from the local region the load balancer is
              # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
              # cannot be changed after the forwarding rule is created.
          &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
              # endpoint can be accessed from another region.
          &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
              # Required for internal and external passthrough Network Load Balancers;
              # must be omitted for all other load balancer types.
          &quot;baseForwardingRule&quot;: &quot;A String&quot;, # [Output Only] The URL for the corresponding base forwarding rule. By base
              # forwarding rule, we mean the forwarding rule that has the same IP address,
              # protocol, and port settings with the current forwarding rule, but without
              # sourceIPRanges specified.
              # Always empty if the current forwarding rule does not have sourceIPRanges
              # specified.
          &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
              # text format.
          &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
              # create the resource.
          &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
              # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
              # TEST_ALL_TRAFFIC.
              #
              # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
              # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
              # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
              # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
              # attached to this forwarding rule by percentage using
              # externalManagedBackendBucketMigrationTestingPercentage.
              #
              # Rolling back a migration requires the states to be set in reverse order. So
              # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
              # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
              # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
              # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
          &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
              # processed by the global external Application Load Balancer.
              #
              # The value of this field must be in the range [0, 100].
              #
              # This value can only be set if the loadBalancingScheme in the BackendService
              # is set to EXTERNAL (when using the classic Application Load Balancer) and
              # the migration state is TEST_BY_PERCENTAGE.
          &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
              # This field is used in optimistic locking. This field will be ignored when
              # inserting a ForwardingRule. Include the fingerprint in patch request to
              # ensure that you do not overwrite changes that were applied from another
              # concurrent request.
              #
              # To see the latest fingerprint, make a get() request to
              # retrieve a ForwardingRule.
          &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
              # defined by the server.
          &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
              # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
              #
              # Use one of the following formats to specify a sub-PDP when creating an IPv6
              # NetLB forwarding rule using BYOIP:
              # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
              # Partial URL, as in:
              #
              #    - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
              #    - regions/region/publicDelegatedPrefixes/sub-pdp-name
          &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule.  Valid options
              # are IPV4 or IPV6.
          &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
              # packet mirroring. To prevent mirroring loops, instances behind this
              # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
              # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
          &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
          &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
              # essentially a hash of the labels set used for optimistic locking. The
              # fingerprint is initially generated by Compute Engine and changes after
              # every request to modify or update labels. You must always provide an
              # up-to-date fingerprint hash in order to update or change labels,
              # otherwise the request will fail with error412 conditionNotMet.
              #
              # To see the latest fingerprint, make a get() request to
              # retrieve a ForwardingRule.
          &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
              # Label values may be empty.
            &quot;a_key&quot;: &quot;A String&quot;,
          },
          &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
              #
              # For more information about forwarding rules, refer to
              # Forwarding rule concepts.
          &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
              # configuration to a limited set of xDS
              # compliant clients. In their xDS requests to load balancer, xDS clients
              # present node
              # metadata. When there is a match, the relevant configuration
              # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
              # referenced by the ForwardingRule are not visible to
              # those proxies.
              #
              # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
              # the metadata. If its filterMatchCriteria is set to
              # MATCH_ALL, then all of its filterLabels must match with
              # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
              # in order to be considered a match.
              #
              # metadataFilters specified here will be applifed before
              # those specified in the UrlMap that thisForwardingRule references.
              #
              # metadataFilters only applies to Loadbalancers that have
              # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
            { # Opaque filter criteria used by load balancers to restrict routing
                # configuration to a limited set of load balancing proxies. Proxies and
                # sidecars involved in load balancing would typically present metadata to the
                # load balancers that need to match criteria specified here. If a match takes
                # place, the relevant configuration is made available to those
                # proxies.
                #
                # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
                # one of thefilterLabels must match the corresponding label provided in
                # the metadata. If its filterMatchCriteria is set to
                # MATCH_ALL, then all of its filterLabels must match with
                # corresponding labels provided in the metadata.
                #
                # An example for using metadataFilters would be: if
                # load balancing involves
                # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in  of their XDS requests to loadbalancers.
              &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
                  # metadata based on filterMatchCriteria
                  #
                  # This list must not be empty and can have at the most 64 entries.
                { # MetadataFilter label name value pairs that are expected
                    # to match corresponding labels presented as metadata to the load balancer.
                  &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
                      #
                      #  The name can have a maximum length of 1024 characters and must be at
                      # least 1 character long.
                  &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
                      #
                      # value can have a maximum length of 1024 characters.
                },
              ],
              &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
                  # within the list of filterLabels and contributes toward the
                  # overall metadataFilter match.
                  #
                  #  Supported values are:
                  #
                  #    - MATCH_ANY: at least one of the filterLabels
                  #    must have a matching label in the provided metadata.
                  #    - MATCH_ALL: all filterLabels must have
                  #    matching labels in the provided metadata.
            },
          ],
          &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
              # The name must be 1-63 characters long, and comply withRFC1035.
              # Specifically, the name must be 1-63 characters long and match the regular
              # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
              # character must be a lowercase letter, and all following characters must
              # be a dash, lowercase letter, or digit, except the last character, which
              # cannot be a dash.
              #
              # For Private Service Connect forwarding rules that forward traffic to Google
              # APIs, the forwarding rule name must be a 1-20 characters string with
              # lowercase letters and numbers and must start with a letter.
          &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
              #
              # For internal passthrough Network Load Balancers, this field identifies the
              # network that the load balanced IP should belong to for this forwarding
              # rule.
              # If the subnetwork is specified, the network of the subnetwork will be used.
              # If neither subnetwork nor this field is specified, the default network will
              # be used.
              #
              # For Private Service Connect forwarding rules that forward traffic to Google
              # APIs, a network must be provided.
          &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
              # this load balancer and can only take the following values:PREMIUM, STANDARD.
              #
              # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
              #
              # If this field is not specified, it is assumed to be PREMIUM.
              # If IPAddress is specified, this value must be equal to the
              # networkTier of the Address.
          &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
              # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
              # this field. Once set, this field is not mutable.
          &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
              # fields are mutually exclusive. Only packets addressed to ports in the
              # specified range will be forwarded to the backends configured with this
              # forwarding rule.
              #
              # The portRange field has the following limitations:
              #
              #    - It requires that the forwarding rule IPProtocol be TCP,
              #    UDP, or SCTP, and
              #    - It&#x27;s applicable only to the following products: external passthrough
              #    Network Load Balancers, internal and external proxy Network Load Balancers,
              #    internal and external Application Load Balancers, external protocol
              #    forwarding, and Classic VPN.
              #    - Some products have restrictions on what ports can be used. See
              #    port specifications for details.
              #
              #
              #
              # For external forwarding rules, two or more forwarding rules cannot use the
              # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
              #
              # For internal forwarding rules within the same VPC network, two or more
              # forwarding rules cannot use the same [IPAddress, IPProtocol]
              # pair, and cannot have overlapping portRanges.
              #
              # @pattern: \\d+(?:-\\d+)?
          &quot;ports&quot;: [ # The ports, portRange, and allPorts
              # fields are mutually exclusive. Only packets addressed to ports in the
              # specified range will be forwarded to the backends configured with this
              # forwarding rule.
              #
              # The ports field has the following limitations:
              #
              #    - It requires that the forwarding rule IPProtocol be TCP,
              #    UDP, or SCTP, and
              #    - It&#x27;s applicable only to the following products: internal passthrough
              #    Network Load Balancers, backend service-based external passthrough Network
              #    Load Balancers, and internal protocol forwarding.
              #    - You can specify a list of up to five ports by number, separated by
              #    commas. The ports can be contiguous or discontiguous.
              #
              #
              #
              # For external forwarding rules, two or more forwarding rules cannot use the
              # same [IPAddress, IPProtocol] pair if they share at least one
              # port number.
              #
              # For internal forwarding rules within the same VPC network, two or more
              # forwarding rules cannot use the same [IPAddress, IPProtocol]
              # pair if they share at least one port number.
              #
              # @pattern: \\d+(?:-\\d+)?
            &quot;A String&quot;,
          ],
          &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
          &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
          &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional forwarding rule resides.
              # This field is not applicable to global forwarding rules.
              # You must specify this field as part of the HTTP request URL. It is
              # not settable as a field in the request body.
          &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
          &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
          &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
              # Currently, only supports a single Service Directory resource.
            { # Describes the auto-registration of the forwarding rule to Service Directory.
                # The region and project of the Service Directory resource generated from
                # this registration will be the same as this forwarding rule.
              &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
              &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
              &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
                  # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
                  # All PSC for Google APIs forwarding rules on the same network should use
                  # the same Service Directory region.
            },
          ],
          &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
              # If specified, the prefix is the first label of the fully qualified service
              # name.
              #
              # The label must be 1-63 characters long, and comply withRFC1035.
              # Specifically, the label must be 1-63 characters long and match the regular
              # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
              # character must be a lowercase letter, and all following characters must
              # be a dash, lowercase letter, or digit, except the last character, which
              # cannot be a dash.
              #
              # This field is only used for internal load balancing.
          &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
              # The internal fully qualified service name for this forwarding rule.
              #
              # This field is only used for internal load balancing.
          &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
              # source IP address matches one of the IP addresses or CIDR ranges set here.
              # Note that a forwarding rule can only have up to 64 source IP ranges, and
              # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
              # Each source_ip_range entry should be either an IP address (for
              # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
            &quot;A String&quot;,
          ],
          &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
              # belong to for this forwarding rule, used with internal load balancers and
              # external passthrough Network Load Balancers with IPv6.
              #
              # If the network specified is in auto subnet mode, this field is optional.
              # However, a subnetwork must be specified if the network is in custom subnet
              # mode or when creating external forwarding rule with IPv6.
          &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic.  For
              # regional forwarding rules, this target must be in the same region as the
              # forwarding rule. For global forwarding rules, this target must be a global
              # load balancing resource.
              #
              # The forwarded traffic must be of a type appropriate to the target object.
              #
              #
              #      -  For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
              #      -  For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
              #
              #
              #             -  vpc-sc -  APIs that support VPC Service Controls.
              #             -  all-apis - All supported Google APIs.
              #
              #
              #      -  For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
        },
      ],
      &quot;warning&quot;: { # Informational warning which replaces the list of forwarding rules when
          # the list is empty.
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
            # Engine returns NO_RESULTS_ON_PAGE if there
            # are no results in the response.
        &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
            # value format. For example:
            #
            # &quot;data&quot;: [
            #   {
            #    &quot;key&quot;: &quot;scope&quot;,
            #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
            #   }
          {
            &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
                # returned. For example, for warnings where there are no results in a list
                # request for a particular zone, this key might be scope and
                # the key value might be the zone name. Other examples might be a key
                # indicating a deprecated resource and a suggested replacement, or a
                # warning about invalid network settings (for example, if an instance
                # attempts to perform IP forwarding but is not enabled for IP forwarding).
            &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
          },
        ],
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#forwardingRuleAggregatedList&quot;, # [Output Only] Type of resource. Alwayscompute#forwardingRuleAggregatedList for lists of forwarding rules.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
      # the query parameter pageToken in the next list request.
      # Subsequent list requests will have their own nextPageToken to
      # continue paging through the results.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
  &quot;unreachables&quot;: [ # [Output Only] Unreachable resources.
    &quot;A String&quot;,
  ],
  &quot;warning&quot;: { # [Output Only] Informational warning message.
    &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
        # Engine returns NO_RESULTS_ON_PAGE if there
        # are no results in the response.
    &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
        # value format. For example:
        #
        # &quot;data&quot;: [
        #   {
        #    &quot;key&quot;: &quot;scope&quot;,
        #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
        #   }
      {
        &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
            # returned. For example, for warnings where there are no results in a list
            # request for a particular zone, this key might be scope and
            # the key value might be the zone name. Other examples might be a key
            # indicating a deprecated resource and a suggested replacement, or a
            # warning about invalid network settings (for example, if an instance
            # attempts to perform IP forwarding but is not enabled for IP forwarding).
        &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(project, region, forwardingRule, requestId=None, x__xgafv=None)</code>
  <pre>Deletes the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to delete. (required)
  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.

For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.

The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(project, region, forwardingRule, x__xgafv=None)</code>
  <pre>Returns the specified ForwardingRule resource.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to return. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a Forwarding Rule resource.
    #
    # Forwarding rule resources in Google Cloud can be either regional or global in
    # scope:
    #
    # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
    # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
    #
    # A forwarding rule and its corresponding IP address represent the frontend
    # configuration of a Google Cloud load balancer.
    # Forwarding rules can also reference target instances and Cloud VPN Classic
    # gateways (targetVpnGateway).
    #
    # For more information, read
    # Forwarding rule concepts and
    # Using protocol forwarding.
  &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
      # sends traffic to this IP address, the forwarding rule directs the traffic
      # to the referenced target or backendService.
      # While creating a forwarding rule, specifying an IPAddress is
      # required under the following circumstances:
      #
      #
      #    - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
      #    - When the target is a Private Service Connect Google APIs
      #    bundle, you must specify an IPAddress.
      #
      #
      # Otherwise, you can optionally specify an IP address that references an
      # existing static (reserved) IP address resource. When omitted, Google Cloud
      # assigns an ephemeral IP address.
      #
      # Use one of the following formats to specify an IP address while creating a
      # forwarding rule:
      #
      # * IP address number, as in `100.1.2.3`
      # * IPv6 address range, as in `2600:1234::/96`
      # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
      # * Partial URL or by name, as in:
      #
      #    - projects/project_id/regions/region/addresses/address-name
      #    - regions/region/addresses/address-name
      #    - global/addresses/address-name
      #    - address-name
      #
      #
      #
      # The forwarding rule&#x27;s target or backendService,
      # and in most cases, also the loadBalancingScheme, determine the
      # type of IP address that you can use. For detailed information, see
      # [IP address
      # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
      #
      # When reading an IPAddress, the API always returns the IP
      # address number.
  &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
      #
      # For protocol forwarding, valid
      # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
      #
      # The valid IP protocols are different for different load balancing products
      # as described in [Load balancing
      # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
  &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      #
      # The allPorts field has the following limitations:
      #
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, SCTP, or L3_DEFAULT.
      #    - It&#x27;s applicable only to the following products: internal passthrough
      #    Network Load Balancers, backend service-based external passthrough Network
      #    Load Balancers, and internal and external protocol forwarding.
      #    - Set this field to true to allow packets addressed to any port or
      #    packets lacking destination port information (for example, UDP fragments
      #    after the first fragment) to be forwarded to the backends configured with
      #    this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
  &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
      # Balancers, the regional internal Application Load Balancer, and the
      # regional internal proxy Network Load Balancer from all regions.
      # If false, only allows access from the local region the load balancer is
      # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
      # cannot be changed after the forwarding rule is created.
  &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
      # endpoint can be accessed from another region.
  &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
      # Required for internal and external passthrough Network Load Balancers;
      # must be omitted for all other load balancer types.
  &quot;baseForwardingRule&quot;: &quot;A String&quot;, # [Output Only] The URL for the corresponding base forwarding rule. By base
      # forwarding rule, we mean the forwarding rule that has the same IP address,
      # protocol, and port settings with the current forwarding rule, but without
      # sourceIPRanges specified.
      # Always empty if the current forwarding rule does not have sourceIPRanges
      # specified.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
      # text format.
  &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
      # create the resource.
  &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
      # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
      # TEST_ALL_TRAFFIC.
      #
      # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
      # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
      # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
      # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
      # attached to this forwarding rule by percentage using
      # externalManagedBackendBucketMigrationTestingPercentage.
      #
      # Rolling back a migration requires the states to be set in reverse order. So
      # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
      # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
      # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
      # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
  &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
      # processed by the global external Application Load Balancer.
      #
      # The value of this field must be in the range [0, 100].
      #
      # This value can only be set if the loadBalancingScheme in the BackendService
      # is set to EXTERNAL (when using the classic Application Load Balancer) and
      # the migration state is TEST_BY_PERCENTAGE.
  &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
      # This field is used in optimistic locking. This field will be ignored when
      # inserting a ForwardingRule. Include the fingerprint in patch request to
      # ensure that you do not overwrite changes that were applied from another
      # concurrent request.
      #
      # To see the latest fingerprint, make a get() request to
      # retrieve a ForwardingRule.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
      # defined by the server.
  &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
      # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
      #
      # Use one of the following formats to specify a sub-PDP when creating an IPv6
      # NetLB forwarding rule using BYOIP:
      # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
      # Partial URL, as in:
      #
      #    - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
      #    - regions/region/publicDelegatedPrefixes/sub-pdp-name
  &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule.  Valid options
      # are IPV4 or IPV6.
  &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
      # packet mirroring. To prevent mirroring loops, instances behind this
      # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
      # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
  &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
  &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
      # essentially a hash of the labels set used for optimistic locking. The
      # fingerprint is initially generated by Compute Engine and changes after
      # every request to modify or update labels. You must always provide an
      # up-to-date fingerprint hash in order to update or change labels,
      # otherwise the request will fail with error412 conditionNotMet.
      #
      # To see the latest fingerprint, make a get() request to
      # retrieve a ForwardingRule.
  &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      # Label values may be empty.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
      #
      # For more information about forwarding rules, refer to
      # Forwarding rule concepts.
  &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
      # configuration to a limited set of xDS
      # compliant clients. In their xDS requests to load balancer, xDS clients
      # present node
      # metadata. When there is a match, the relevant configuration
      # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
      # referenced by the ForwardingRule are not visible to
      # those proxies.
      #
      # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
      # the metadata. If its filterMatchCriteria is set to
      # MATCH_ALL, then all of its filterLabels must match with
      # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
      # in order to be considered a match.
      #
      # metadataFilters specified here will be applifed before
      # those specified in the UrlMap that thisForwardingRule references.
      #
      # metadataFilters only applies to Loadbalancers that have
      # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
    { # Opaque filter criteria used by load balancers to restrict routing
        # configuration to a limited set of load balancing proxies. Proxies and
        # sidecars involved in load balancing would typically present metadata to the
        # load balancers that need to match criteria specified here. If a match takes
        # place, the relevant configuration is made available to those
        # proxies.
        #
        # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
        # one of thefilterLabels must match the corresponding label provided in
        # the metadata. If its filterMatchCriteria is set to
        # MATCH_ALL, then all of its filterLabels must match with
        # corresponding labels provided in the metadata.
        #
        # An example for using metadataFilters would be: if
        # load balancing involves
        # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in  of their XDS requests to loadbalancers.
      &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
          # metadata based on filterMatchCriteria
          #
          # This list must not be empty and can have at the most 64 entries.
        { # MetadataFilter label name value pairs that are expected
            # to match corresponding labels presented as metadata to the load balancer.
          &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
              #
              #  The name can have a maximum length of 1024 characters and must be at
              # least 1 character long.
          &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
              #
              # value can have a maximum length of 1024 characters.
        },
      ],
      &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
          # within the list of filterLabels and contributes toward the
          # overall metadataFilter match.
          #
          #  Supported values are:
          #
          #    - MATCH_ANY: at least one of the filterLabels
          #    must have a matching label in the provided metadata.
          #    - MATCH_ALL: all filterLabels must have
          #    matching labels in the provided metadata.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
      # The name must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the name must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must
      # be a dash, lowercase letter, or digit, except the last character, which
      # cannot be a dash.
      #
      # For Private Service Connect forwarding rules that forward traffic to Google
      # APIs, the forwarding rule name must be a 1-20 characters string with
      # lowercase letters and numbers and must start with a letter.
  &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
      #
      # For internal passthrough Network Load Balancers, this field identifies the
      # network that the load balanced IP should belong to for this forwarding
      # rule.
      # If the subnetwork is specified, the network of the subnetwork will be used.
      # If neither subnetwork nor this field is specified, the default network will
      # be used.
      #
      # For Private Service Connect forwarding rules that forward traffic to Google
      # APIs, a network must be provided.
  &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
      # this load balancer and can only take the following values:PREMIUM, STANDARD.
      #
      # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
      #
      # If this field is not specified, it is assumed to be PREMIUM.
      # If IPAddress is specified, this value must be equal to the
      # networkTier of the Address.
  &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
      # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
      # this field. Once set, this field is not mutable.
  &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      #
      # The portRange field has the following limitations:
      #
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, or SCTP, and
      #    - It&#x27;s applicable only to the following products: external passthrough
      #    Network Load Balancers, internal and external proxy Network Load Balancers,
      #    internal and external Application Load Balancers, external protocol
      #    forwarding, and Classic VPN.
      #    - Some products have restrictions on what ports can be used. See
      #    port specifications for details.
      #
      #
      #
      # For external forwarding rules, two or more forwarding rules cannot use the
      # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
      #
      # For internal forwarding rules within the same VPC network, two or more
      # forwarding rules cannot use the same [IPAddress, IPProtocol]
      # pair, and cannot have overlapping portRanges.
      #
      # @pattern: \\d+(?:-\\d+)?
  &quot;ports&quot;: [ # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      #
      # The ports field has the following limitations:
      #
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, or SCTP, and
      #    - It&#x27;s applicable only to the following products: internal passthrough
      #    Network Load Balancers, backend service-based external passthrough Network
      #    Load Balancers, and internal protocol forwarding.
      #    - You can specify a list of up to five ports by number, separated by
      #    commas. The ports can be contiguous or discontiguous.
      #
      #
      #
      # For external forwarding rules, two or more forwarding rules cannot use the
      # same [IPAddress, IPProtocol] pair if they share at least one
      # port number.
      #
      # For internal forwarding rules within the same VPC network, two or more
      # forwarding rules cannot use the same [IPAddress, IPProtocol]
      # pair if they share at least one port number.
      #
      # @pattern: \\d+(?:-\\d+)?
    &quot;A String&quot;,
  ],
  &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
  &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional forwarding rule resides.
      # This field is not applicable to global forwarding rules.
      # You must specify this field as part of the HTTP request URL. It is
      # not settable as a field in the request body.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
  &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
      # Currently, only supports a single Service Directory resource.
    { # Describes the auto-registration of the forwarding rule to Service Directory.
        # The region and project of the Service Directory resource generated from
        # this registration will be the same as this forwarding rule.
      &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
      &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
      &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
          # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
          # All PSC for Google APIs forwarding rules on the same network should use
          # the same Service Directory region.
    },
  ],
  &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
      # If specified, the prefix is the first label of the fully qualified service
      # name.
      #
      # The label must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the label must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must
      # be a dash, lowercase letter, or digit, except the last character, which
      # cannot be a dash.
      #
      # This field is only used for internal load balancing.
  &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
      # The internal fully qualified service name for this forwarding rule.
      #
      # This field is only used for internal load balancing.
  &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
      # source IP address matches one of the IP addresses or CIDR ranges set here.
      # Note that a forwarding rule can only have up to 64 source IP ranges, and
      # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
      # Each source_ip_range entry should be either an IP address (for
      # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
    &quot;A String&quot;,
  ],
  &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
      # belong to for this forwarding rule, used with internal load balancers and
      # external passthrough Network Load Balancers with IPv6.
      #
      # If the network specified is in auto subnet mode, this field is optional.
      # However, a subnetwork must be specified if the network is in custom subnet
      # mode or when creating external forwarding rule with IPv6.
  &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic.  For
      # regional forwarding rules, this target must be in the same region as the
      # forwarding rule. For global forwarding rules, this target must be a global
      # load balancing resource.
      #
      # The forwarded traffic must be of a type appropriate to the target object.
      #
      #
      #      -  For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
      #      -  For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
      #
      #
      #             -  vpc-sc -  APIs that support VPC Service Controls.
      #             -  all-apis - All supported Google APIs.
      #
      #
      #      -  For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
  <pre>Creates a ForwardingRule resource in the specified project and region using
the data included in the request.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Forwarding Rule resource.
    # 
    # Forwarding rule resources in Google Cloud can be either regional or global in
    # scope:
    # 
    # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
    # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
    # 
    # A forwarding rule and its corresponding IP address represent the frontend
    # configuration of a Google Cloud load balancer.
    # Forwarding rules can also reference target instances and Cloud VPN Classic
    # gateways (targetVpnGateway).
    # 
    # For more information, read
    # Forwarding rule concepts and
    # Using protocol forwarding.
  &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
      # sends traffic to this IP address, the forwarding rule directs the traffic
      # to the referenced target or backendService.
      # While creating a forwarding rule, specifying an IPAddress is
      # required under the following circumstances:
      # 
      # 
      #    - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
      #    - When the target is a Private Service Connect Google APIs
      #    bundle, you must specify an IPAddress.
      # 
      # 
      # Otherwise, you can optionally specify an IP address that references an
      # existing static (reserved) IP address resource. When omitted, Google Cloud
      # assigns an ephemeral IP address.
      # 
      # Use one of the following formats to specify an IP address while creating a
      # forwarding rule:
      # 
      # * IP address number, as in `100.1.2.3`
      # * IPv6 address range, as in `2600:1234::/96`
      # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
      # * Partial URL or by name, as in:
      # 
      #    - projects/project_id/regions/region/addresses/address-name
      #    - regions/region/addresses/address-name
      #    - global/addresses/address-name
      #    - address-name
      # 
      # 
      # 
      # The forwarding rule&#x27;s target or backendService,
      # and in most cases, also the loadBalancingScheme, determine the
      # type of IP address that you can use. For detailed information, see
      # [IP address
      # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
      # 
      # When reading an IPAddress, the API always returns the IP
      # address number.
  &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
      # 
      # For protocol forwarding, valid
      # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
      # 
      # The valid IP protocols are different for different load balancing products
      # as described in [Load balancing
      # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
  &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      # 
      # The allPorts field has the following limitations:
      # 
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, SCTP, or L3_DEFAULT.
      #    - It&#x27;s applicable only to the following products: internal passthrough
      #    Network Load Balancers, backend service-based external passthrough Network
      #    Load Balancers, and internal and external protocol forwarding.
      #    - Set this field to true to allow packets addressed to any port or
      #    packets lacking destination port information (for example, UDP fragments
      #    after the first fragment) to be forwarded to the backends configured with
      #    this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
  &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
      # Balancers, the regional internal Application Load Balancer, and the
      # regional internal proxy Network Load Balancer from all regions.
      # If false, only allows access from the local region the load balancer is
      # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
      # cannot be changed after the forwarding rule is created.
  &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
      # endpoint can be accessed from another region.
  &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
      # Required for internal and external passthrough Network Load Balancers;
      # must be omitted for all other load balancer types.
  &quot;baseForwardingRule&quot;: &quot;A String&quot;, # [Output Only] The URL for the corresponding base forwarding rule. By base
      # forwarding rule, we mean the forwarding rule that has the same IP address,
      # protocol, and port settings with the current forwarding rule, but without
      # sourceIPRanges specified.
      # Always empty if the current forwarding rule does not have sourceIPRanges
      # specified.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
      # text format.
  &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
      # create the resource.
  &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
      # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
      # TEST_ALL_TRAFFIC.
      # 
      # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
      # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
      # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
      # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
      # attached to this forwarding rule by percentage using
      # externalManagedBackendBucketMigrationTestingPercentage.
      # 
      # Rolling back a migration requires the states to be set in reverse order. So
      # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
      # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
      # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
      # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
  &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
      # processed by the global external Application Load Balancer.
      # 
      # The value of this field must be in the range [0, 100].
      # 
      # This value can only be set if the loadBalancingScheme in the BackendService
      # is set to EXTERNAL (when using the classic Application Load Balancer) and
      # the migration state is TEST_BY_PERCENTAGE.
  &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
      # This field is used in optimistic locking. This field will be ignored when
      # inserting a ForwardingRule. Include the fingerprint in patch request to
      # ensure that you do not overwrite changes that were applied from another
      # concurrent request.
      # 
      # To see the latest fingerprint, make a get() request to
      # retrieve a ForwardingRule.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
      # defined by the server.
  &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
      # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
      # 
      # Use one of the following formats to specify a sub-PDP when creating an IPv6
      # NetLB forwarding rule using BYOIP:
      # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
      # Partial URL, as in:
      # 
      #    - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
      #    - regions/region/publicDelegatedPrefixes/sub-pdp-name
  &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule.  Valid options
      # are IPV4 or IPV6.
  &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
      # packet mirroring. To prevent mirroring loops, instances behind this
      # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
      # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
  &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
  &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
      # essentially a hash of the labels set used for optimistic locking. The
      # fingerprint is initially generated by Compute Engine and changes after
      # every request to modify or update labels. You must always provide an
      # up-to-date fingerprint hash in order to update or change labels,
      # otherwise the request will fail with error412 conditionNotMet.
      # 
      # To see the latest fingerprint, make a get() request to
      # retrieve a ForwardingRule.
  &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      # Label values may be empty.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
      # 
      # For more information about forwarding rules, refer to
      # Forwarding rule concepts.
  &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
      # configuration to a limited set of xDS
      # compliant clients. In their xDS requests to load balancer, xDS clients
      # present node
      # metadata. When there is a match, the relevant configuration
      # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
      # referenced by the ForwardingRule are not visible to
      # those proxies.
      # 
      # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
      # the metadata. If its filterMatchCriteria is set to
      # MATCH_ALL, then all of its filterLabels must match with
      # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
      # in order to be considered a match.
      # 
      # metadataFilters specified here will be applifed before
      # those specified in the UrlMap that thisForwardingRule references.
      # 
      # metadataFilters only applies to Loadbalancers that have
      # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
    { # Opaque filter criteria used by load balancers to restrict routing
        # configuration to a limited set of load balancing proxies. Proxies and
        # sidecars involved in load balancing would typically present metadata to the
        # load balancers that need to match criteria specified here. If a match takes
        # place, the relevant configuration is made available to those
        # proxies.
        #
        # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
        # one of thefilterLabels must match the corresponding label provided in
        # the metadata. If its filterMatchCriteria is set to
        # MATCH_ALL, then all of its filterLabels must match with
        # corresponding labels provided in the metadata.
        #
        # An example for using metadataFilters would be: if
        # load balancing involves
        # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in  of their XDS requests to loadbalancers.
      &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
          # metadata based on filterMatchCriteria
          #
          # This list must not be empty and can have at the most 64 entries.
        { # MetadataFilter label name value pairs that are expected
            # to match corresponding labels presented as metadata to the load balancer.
          &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
              #
              #  The name can have a maximum length of 1024 characters and must be at
              # least 1 character long.
          &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
              #
              # value can have a maximum length of 1024 characters.
        },
      ],
      &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
          # within the list of filterLabels and contributes toward the
          # overall metadataFilter match.
          #
          #  Supported values are:
          #
          #    - MATCH_ANY: at least one of the filterLabels
          #    must have a matching label in the provided metadata.
          #    - MATCH_ALL: all filterLabels must have
          #    matching labels in the provided metadata.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
      # The name must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the name must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must
      # be a dash, lowercase letter, or digit, except the last character, which
      # cannot be a dash.
      # 
      # For Private Service Connect forwarding rules that forward traffic to Google
      # APIs, the forwarding rule name must be a 1-20 characters string with
      # lowercase letters and numbers and must start with a letter.
  &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
      # 
      # For internal passthrough Network Load Balancers, this field identifies the
      # network that the load balanced IP should belong to for this forwarding
      # rule.
      # If the subnetwork is specified, the network of the subnetwork will be used.
      # If neither subnetwork nor this field is specified, the default network will
      # be used.
      # 
      # For Private Service Connect forwarding rules that forward traffic to Google
      # APIs, a network must be provided.
  &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
      # this load balancer and can only take the following values:PREMIUM, STANDARD.
      # 
      # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
      # 
      # If this field is not specified, it is assumed to be PREMIUM.
      # If IPAddress is specified, this value must be equal to the
      # networkTier of the Address.
  &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
      # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
      # this field. Once set, this field is not mutable.
  &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      # 
      # The portRange field has the following limitations:
      # 
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, or SCTP, and
      #    - It&#x27;s applicable only to the following products: external passthrough
      #    Network Load Balancers, internal and external proxy Network Load Balancers,
      #    internal and external Application Load Balancers, external protocol
      #    forwarding, and Classic VPN.
      #    - Some products have restrictions on what ports can be used. See
      #    port specifications for details.
      # 
      # 
      # 
      # For external forwarding rules, two or more forwarding rules cannot use the
      # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
      # 
      # For internal forwarding rules within the same VPC network, two or more
      # forwarding rules cannot use the same [IPAddress, IPProtocol]
      # pair, and cannot have overlapping portRanges.
      # 
      # @pattern: \\d+(?:-\\d+)?
  &quot;ports&quot;: [ # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      # 
      # The ports field has the following limitations:
      # 
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, or SCTP, and
      #    - It&#x27;s applicable only to the following products: internal passthrough
      #    Network Load Balancers, backend service-based external passthrough Network
      #    Load Balancers, and internal protocol forwarding.
      #    - You can specify a list of up to five ports by number, separated by
      #    commas. The ports can be contiguous or discontiguous.
      # 
      # 
      # 
      # For external forwarding rules, two or more forwarding rules cannot use the
      # same [IPAddress, IPProtocol] pair if they share at least one
      # port number.
      # 
      # For internal forwarding rules within the same VPC network, two or more
      # forwarding rules cannot use the same [IPAddress, IPProtocol]
      # pair if they share at least one port number.
      # 
      # @pattern: \\d+(?:-\\d+)?
    &quot;A String&quot;,
  ],
  &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
  &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional forwarding rule resides.
      # This field is not applicable to global forwarding rules.
      # You must specify this field as part of the HTTP request URL. It is
      # not settable as a field in the request body.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
  &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
      # Currently, only supports a single Service Directory resource.
    { # Describes the auto-registration of the forwarding rule to Service Directory.
        # The region and project of the Service Directory resource generated from
        # this registration will be the same as this forwarding rule.
      &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
      &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
      &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
          # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
          # All PSC for Google APIs forwarding rules on the same network should use
          # the same Service Directory region.
    },
  ],
  &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
      # If specified, the prefix is the first label of the fully qualified service
      # name.
      # 
      # The label must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the label must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must
      # be a dash, lowercase letter, or digit, except the last character, which
      # cannot be a dash.
      # 
      # This field is only used for internal load balancing.
  &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
      # The internal fully qualified service name for this forwarding rule.
      # 
      # This field is only used for internal load balancing.
  &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
      # source IP address matches one of the IP addresses or CIDR ranges set here.
      # Note that a forwarding rule can only have up to 64 source IP ranges, and
      # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
      # Each source_ip_range entry should be either an IP address (for
      # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
    &quot;A String&quot;,
  ],
  &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
      # belong to for this forwarding rule, used with internal load balancers and
      # external passthrough Network Load Balancers with IPv6.
      # 
      # If the network specified is in auto subnet mode, this field is optional.
      # However, a subnetwork must be specified if the network is in custom subnet
      # mode or when creating external forwarding rule with IPv6.
  &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic.  For
      # regional forwarding rules, this target must be in the same region as the
      # forwarding rule. For global forwarding rules, this target must be a global
      # load balancing resource.
      # 
      # The forwarded traffic must be of a type appropriate to the target object.
      # 
      # 
      #      -  For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
      #      -  For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
      # 
      # 
      #             -  vpc-sc -  APIs that support VPC Service Controls.
      #             -  all-apis - All supported Google APIs.
      # 
      # 
      #      -  For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
}

  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.

For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.

The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
  <pre>Retrieves a list of ForwardingRule resources available to the specified
project and region.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  filter: string, A filter expression that filters resources listed in the response. Most
Compute resources support two types of filter expressions:
expressions that support regular expressions and expressions that follow
API improvement proposal AIP-160.
These two types of filter expressions cannot be mixed in one request.

If you want to use AIP-160, your expression must specify the field name, an
operator, and the value that you want to use for filtering. The value
must be a string, a number, or a boolean. The operator
must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.

For example, if you are filtering Compute Engine instances, you can
exclude instances named `example-instance` by specifying
`name != example-instance`.

The `:*` comparison can be used to test whether a key has been defined.
For example, to find all objects with `owner` label use:
```
labels.owner:*
```

You can also filter nested fields. For example, you could specify
`scheduling.automaticRestart = false` to include instances only
if they are not scheduled for automatic restarts. You can use filtering
on nested fields to filter based onresource labels.

To filter on multiple expressions, provide each separate expression within
parentheses. For example:
```
(scheduling.automaticRestart = true)
(cpuPlatform = &quot;Intel Skylake&quot;)
```
By default, each expression is an `AND` expression. However, you
can include `AND` and `OR` expressions explicitly.
For example:
```
(cpuPlatform = &quot;Intel Skylake&quot;) OR
(cpuPlatform = &quot;Intel Broadwell&quot;) AND
(scheduling.automaticRestart = true)
```

If you want to use a regular expression, use the `eq` (equal) or `ne`
(not equal) operator against a single un-parenthesized expression with or
without quotes or against multiple parenthesized expressions. Examples:

`fieldname eq unquoted literal`
`fieldname eq &#x27;single quoted literal&#x27;`
`fieldname eq &quot;double quoted literal&quot;`
`(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`

The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
The literal value must match the entire field.

For example, to filter for instances that do not end with name &quot;instance&quot;,
you would use `name ne .*instance`.

You cannot combine constraints on multiple fields using regular
expressions.
  maxResults: integer, The maximum number of results per page that should be returned.
If the number of available results is larger than `maxResults`,
Compute Engine returns a `nextPageToken` that can be used to get
the next page of results in subsequent list requests. Acceptable values are
`0` to `500`, inclusive. (Default: `500`)
  orderBy: string, Sorts list results by a certain order. By default, results
are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation
timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
results based on the `creationTimestamp` field in
reverse chronological order (newest result first). Use this to sort
resources like operations so that the newest operation is returned first.

Currently, only sorting by `name` or
`creationTimestamp desc` is supported.
  pageToken: string, Specifies a page token to use. Set `pageToken` to the
`nextPageToken` returned by a previous list request to get
the next page of results.
  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
of failure. The default value is false.

For example, when partial success behavior is enabled, aggregatedList for a
single zone scope either returns all resources in the zone or no resources,
with an error code.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains a list of ForwardingRule resources.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
  &quot;items&quot;: [ # A list of ForwardingRule resources.
    { # Represents a Forwarding Rule resource.
        #
        # Forwarding rule resources in Google Cloud can be either regional or global in
        # scope:
        #
        # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
        # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
        #
        # A forwarding rule and its corresponding IP address represent the frontend
        # configuration of a Google Cloud load balancer.
        # Forwarding rules can also reference target instances and Cloud VPN Classic
        # gateways (targetVpnGateway).
        #
        # For more information, read
        # Forwarding rule concepts and
        # Using protocol forwarding.
      &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
          # sends traffic to this IP address, the forwarding rule directs the traffic
          # to the referenced target or backendService.
          # While creating a forwarding rule, specifying an IPAddress is
          # required under the following circumstances:
          #
          #
          #    - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
          #    - When the target is a Private Service Connect Google APIs
          #    bundle, you must specify an IPAddress.
          #
          #
          # Otherwise, you can optionally specify an IP address that references an
          # existing static (reserved) IP address resource. When omitted, Google Cloud
          # assigns an ephemeral IP address.
          #
          # Use one of the following formats to specify an IP address while creating a
          # forwarding rule:
          #
          # * IP address number, as in `100.1.2.3`
          # * IPv6 address range, as in `2600:1234::/96`
          # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
          # * Partial URL or by name, as in:
          #
          #    - projects/project_id/regions/region/addresses/address-name
          #    - regions/region/addresses/address-name
          #    - global/addresses/address-name
          #    - address-name
          #
          #
          #
          # The forwarding rule&#x27;s target or backendService,
          # and in most cases, also the loadBalancingScheme, determine the
          # type of IP address that you can use. For detailed information, see
          # [IP address
          # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
          #
          # When reading an IPAddress, the API always returns the IP
          # address number.
      &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
          #
          # For protocol forwarding, valid
          # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
          #
          # The valid IP protocols are different for different load balancing products
          # as described in [Load balancing
          # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
      &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
          # fields are mutually exclusive. Only packets addressed to ports in the
          # specified range will be forwarded to the backends configured with this
          # forwarding rule.
          #
          # The allPorts field has the following limitations:
          #
          #    - It requires that the forwarding rule IPProtocol be TCP,
          #    UDP, SCTP, or L3_DEFAULT.
          #    - It&#x27;s applicable only to the following products: internal passthrough
          #    Network Load Balancers, backend service-based external passthrough Network
          #    Load Balancers, and internal and external protocol forwarding.
          #    - Set this field to true to allow packets addressed to any port or
          #    packets lacking destination port information (for example, UDP fragments
          #    after the first fragment) to be forwarded to the backends configured with
          #    this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
      &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
          # Balancers, the regional internal Application Load Balancer, and the
          # regional internal proxy Network Load Balancer from all regions.
          # If false, only allows access from the local region the load balancer is
          # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
          # cannot be changed after the forwarding rule is created.
      &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
          # endpoint can be accessed from another region.
      &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
          # Required for internal and external passthrough Network Load Balancers;
          # must be omitted for all other load balancer types.
      &quot;baseForwardingRule&quot;: &quot;A String&quot;, # [Output Only] The URL for the corresponding base forwarding rule. By base
          # forwarding rule, we mean the forwarding rule that has the same IP address,
          # protocol, and port settings with the current forwarding rule, but without
          # sourceIPRanges specified.
          # Always empty if the current forwarding rule does not have sourceIPRanges
          # specified.
      &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
          # text format.
      &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
          # create the resource.
      &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
          # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
          # TEST_ALL_TRAFFIC.
          #
          # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
          # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
          # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
          # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
          # attached to this forwarding rule by percentage using
          # externalManagedBackendBucketMigrationTestingPercentage.
          #
          # Rolling back a migration requires the states to be set in reverse order. So
          # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
          # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
          # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
          # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
      &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
          # processed by the global external Application Load Balancer.
          #
          # The value of this field must be in the range [0, 100].
          #
          # This value can only be set if the loadBalancingScheme in the BackendService
          # is set to EXTERNAL (when using the classic Application Load Balancer) and
          # the migration state is TEST_BY_PERCENTAGE.
      &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
          # This field is used in optimistic locking. This field will be ignored when
          # inserting a ForwardingRule. Include the fingerprint in patch request to
          # ensure that you do not overwrite changes that were applied from another
          # concurrent request.
          #
          # To see the latest fingerprint, make a get() request to
          # retrieve a ForwardingRule.
      &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
          # defined by the server.
      &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
          # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
          #
          # Use one of the following formats to specify a sub-PDP when creating an IPv6
          # NetLB forwarding rule using BYOIP:
          # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
          # Partial URL, as in:
          #
          #    - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
          #    - regions/region/publicDelegatedPrefixes/sub-pdp-name
      &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule.  Valid options
          # are IPV4 or IPV6.
      &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
          # packet mirroring. To prevent mirroring loops, instances behind this
          # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
          # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
      &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
      &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
          # essentially a hash of the labels set used for optimistic locking. The
          # fingerprint is initially generated by Compute Engine and changes after
          # every request to modify or update labels. You must always provide an
          # up-to-date fingerprint hash in order to update or change labels,
          # otherwise the request will fail with error412 conditionNotMet.
          #
          # To see the latest fingerprint, make a get() request to
          # retrieve a ForwardingRule.
      &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
          # Label values may be empty.
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
          #
          # For more information about forwarding rules, refer to
          # Forwarding rule concepts.
      &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
          # configuration to a limited set of xDS
          # compliant clients. In their xDS requests to load balancer, xDS clients
          # present node
          # metadata. When there is a match, the relevant configuration
          # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
          # referenced by the ForwardingRule are not visible to
          # those proxies.
          #
          # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
          # the metadata. If its filterMatchCriteria is set to
          # MATCH_ALL, then all of its filterLabels must match with
          # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
          # in order to be considered a match.
          #
          # metadataFilters specified here will be applifed before
          # those specified in the UrlMap that thisForwardingRule references.
          #
          # metadataFilters only applies to Loadbalancers that have
          # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
        { # Opaque filter criteria used by load balancers to restrict routing
            # configuration to a limited set of load balancing proxies. Proxies and
            # sidecars involved in load balancing would typically present metadata to the
            # load balancers that need to match criteria specified here. If a match takes
            # place, the relevant configuration is made available to those
            # proxies.
            #
            # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
            # one of thefilterLabels must match the corresponding label provided in
            # the metadata. If its filterMatchCriteria is set to
            # MATCH_ALL, then all of its filterLabels must match with
            # corresponding labels provided in the metadata.
            #
            # An example for using metadataFilters would be: if
            # load balancing involves
            # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in  of their XDS requests to loadbalancers.
          &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
              # metadata based on filterMatchCriteria
              #
              # This list must not be empty and can have at the most 64 entries.
            { # MetadataFilter label name value pairs that are expected
                # to match corresponding labels presented as metadata to the load balancer.
              &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
                  #
                  #  The name can have a maximum length of 1024 characters and must be at
                  # least 1 character long.
              &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
                  #
                  # value can have a maximum length of 1024 characters.
            },
          ],
          &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
              # within the list of filterLabels and contributes toward the
              # overall metadataFilter match.
              #
              #  Supported values are:
              #
              #    - MATCH_ANY: at least one of the filterLabels
              #    must have a matching label in the provided metadata.
              #    - MATCH_ALL: all filterLabels must have
              #    matching labels in the provided metadata.
        },
      ],
      &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
          # The name must be 1-63 characters long, and comply withRFC1035.
          # Specifically, the name must be 1-63 characters long and match the regular
          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
          # character must be a lowercase letter, and all following characters must
          # be a dash, lowercase letter, or digit, except the last character, which
          # cannot be a dash.
          #
          # For Private Service Connect forwarding rules that forward traffic to Google
          # APIs, the forwarding rule name must be a 1-20 characters string with
          # lowercase letters and numbers and must start with a letter.
      &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
          #
          # For internal passthrough Network Load Balancers, this field identifies the
          # network that the load balanced IP should belong to for this forwarding
          # rule.
          # If the subnetwork is specified, the network of the subnetwork will be used.
          # If neither subnetwork nor this field is specified, the default network will
          # be used.
          #
          # For Private Service Connect forwarding rules that forward traffic to Google
          # APIs, a network must be provided.
      &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
          # this load balancer and can only take the following values:PREMIUM, STANDARD.
          #
          # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
          #
          # If this field is not specified, it is assumed to be PREMIUM.
          # If IPAddress is specified, this value must be equal to the
          # networkTier of the Address.
      &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
          # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
          # this field. Once set, this field is not mutable.
      &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
          # fields are mutually exclusive. Only packets addressed to ports in the
          # specified range will be forwarded to the backends configured with this
          # forwarding rule.
          #
          # The portRange field has the following limitations:
          #
          #    - It requires that the forwarding rule IPProtocol be TCP,
          #    UDP, or SCTP, and
          #    - It&#x27;s applicable only to the following products: external passthrough
          #    Network Load Balancers, internal and external proxy Network Load Balancers,
          #    internal and external Application Load Balancers, external protocol
          #    forwarding, and Classic VPN.
          #    - Some products have restrictions on what ports can be used. See
          #    port specifications for details.
          #
          #
          #
          # For external forwarding rules, two or more forwarding rules cannot use the
          # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
          #
          # For internal forwarding rules within the same VPC network, two or more
          # forwarding rules cannot use the same [IPAddress, IPProtocol]
          # pair, and cannot have overlapping portRanges.
          #
          # @pattern: \\d+(?:-\\d+)?
      &quot;ports&quot;: [ # The ports, portRange, and allPorts
          # fields are mutually exclusive. Only packets addressed to ports in the
          # specified range will be forwarded to the backends configured with this
          # forwarding rule.
          #
          # The ports field has the following limitations:
          #
          #    - It requires that the forwarding rule IPProtocol be TCP,
          #    UDP, or SCTP, and
          #    - It&#x27;s applicable only to the following products: internal passthrough
          #    Network Load Balancers, backend service-based external passthrough Network
          #    Load Balancers, and internal protocol forwarding.
          #    - You can specify a list of up to five ports by number, separated by
          #    commas. The ports can be contiguous or discontiguous.
          #
          #
          #
          # For external forwarding rules, two or more forwarding rules cannot use the
          # same [IPAddress, IPProtocol] pair if they share at least one
          # port number.
          #
          # For internal forwarding rules within the same VPC network, two or more
          # forwarding rules cannot use the same [IPAddress, IPProtocol]
          # pair if they share at least one port number.
          #
          # @pattern: \\d+(?:-\\d+)?
        &quot;A String&quot;,
      ],
      &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
      &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
      &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional forwarding rule resides.
          # This field is not applicable to global forwarding rules.
          # You must specify this field as part of the HTTP request URL. It is
          # not settable as a field in the request body.
      &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
      &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
      &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
          # Currently, only supports a single Service Directory resource.
        { # Describes the auto-registration of the forwarding rule to Service Directory.
            # The region and project of the Service Directory resource generated from
            # this registration will be the same as this forwarding rule.
          &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
          &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
          &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
              # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
              # All PSC for Google APIs forwarding rules on the same network should use
              # the same Service Directory region.
        },
      ],
      &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
          # If specified, the prefix is the first label of the fully qualified service
          # name.
          #
          # The label must be 1-63 characters long, and comply withRFC1035.
          # Specifically, the label must be 1-63 characters long and match the regular
          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
          # character must be a lowercase letter, and all following characters must
          # be a dash, lowercase letter, or digit, except the last character, which
          # cannot be a dash.
          #
          # This field is only used for internal load balancing.
      &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
          # The internal fully qualified service name for this forwarding rule.
          #
          # This field is only used for internal load balancing.
      &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
          # source IP address matches one of the IP addresses or CIDR ranges set here.
          # Note that a forwarding rule can only have up to 64 source IP ranges, and
          # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
          # Each source_ip_range entry should be either an IP address (for
          # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
        &quot;A String&quot;,
      ],
      &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
          # belong to for this forwarding rule, used with internal load balancers and
          # external passthrough Network Load Balancers with IPv6.
          #
          # If the network specified is in auto subnet mode, this field is optional.
          # However, a subnetwork must be specified if the network is in custom subnet
          # mode or when creating external forwarding rule with IPv6.
      &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic.  For
          # regional forwarding rules, this target must be in the same region as the
          # forwarding rule. For global forwarding rules, this target must be a global
          # load balancing resource.
          #
          # The forwarded traffic must be of a type appropriate to the target object.
          #
          #
          #      -  For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
          #      -  For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
          #
          #
          #             -  vpc-sc -  APIs that support VPC Service Controls.
          #             -  all-apis - All supported Google APIs.
          #
          #
          #      -  For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
    },
  ],
  &quot;kind&quot;: &quot;compute#forwardingRuleList&quot;, # Type of resource.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
      # the query parameter pageToken in the next list request.
      # Subsequent list requests will have their own nextPageToken to
      # continue paging through the results.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
  &quot;warning&quot;: { # [Output Only] Informational warning message.
    &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
        # Engine returns NO_RESULTS_ON_PAGE if there
        # are no results in the response.
    &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
        # value format. For example:
        #
        # &quot;data&quot;: [
        #   {
        #    &quot;key&quot;: &quot;scope&quot;,
        #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
        #   }
      {
        &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
            # returned. For example, for warnings where there are no results in a list
            # request for a particular zone, this key might be scope and
            # the key value might be the zone name. Other examples might be a key
            # indicating a deprecated resource and a suggested replacement, or a
            # warning about invalid network settings (for example, if an instance
            # attempts to perform IP forwarding but is not enabled for IP forwarding).
        &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(project, region, forwardingRule, body=None, requestId=None, x__xgafv=None)</code>
  <pre>Updates the specified forwarding rule with the data included in the
request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules. Currently, you can only
patch the network_tier field.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource to patch. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a Forwarding Rule resource.
    # 
    # Forwarding rule resources in Google Cloud can be either regional or global in
    # scope:
    # 
    # * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)
    # * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)
    # 
    # A forwarding rule and its corresponding IP address represent the frontend
    # configuration of a Google Cloud load balancer.
    # Forwarding rules can also reference target instances and Cloud VPN Classic
    # gateways (targetVpnGateway).
    # 
    # For more information, read
    # Forwarding rule concepts and
    # Using protocol forwarding.
  &quot;IPAddress&quot;: &quot;A String&quot;, # IP address for which this forwarding rule accepts traffic. When a client
      # sends traffic to this IP address, the forwarding rule directs the traffic
      # to the referenced target or backendService.
      # While creating a forwarding rule, specifying an IPAddress is
      # required under the following circumstances:
      # 
      # 
      #    - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.
      #    - When the target is a Private Service Connect Google APIs
      #    bundle, you must specify an IPAddress.
      # 
      # 
      # Otherwise, you can optionally specify an IP address that references an
      # existing static (reserved) IP address resource. When omitted, Google Cloud
      # assigns an ephemeral IP address.
      # 
      # Use one of the following formats to specify an IP address while creating a
      # forwarding rule:
      # 
      # * IP address number, as in `100.1.2.3`
      # * IPv6 address range, as in `2600:1234::/96`
      # * Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name
      # * Partial URL or by name, as in:
      # 
      #    - projects/project_id/regions/region/addresses/address-name
      #    - regions/region/addresses/address-name
      #    - global/addresses/address-name
      #    - address-name
      # 
      # 
      # 
      # The forwarding rule&#x27;s target or backendService,
      # and in most cases, also the loadBalancingScheme, determine the
      # type of IP address that you can use. For detailed information, see
      # [IP address
      # specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
      # 
      # When reading an IPAddress, the API always returns the IP
      # address number.
  &quot;IPProtocol&quot;: &quot;A String&quot;, # The IP protocol to which this rule applies.
      # 
      # For protocol forwarding, valid
      # options are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.
      # 
      # The valid IP protocols are different for different load balancing products
      # as described in [Load balancing
      # features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
  &quot;allPorts&quot;: True or False, # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      # 
      # The allPorts field has the following limitations:
      # 
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, SCTP, or L3_DEFAULT.
      #    - It&#x27;s applicable only to the following products: internal passthrough
      #    Network Load Balancers, backend service-based external passthrough Network
      #    Load Balancers, and internal and external protocol forwarding.
      #    - Set this field to true to allow packets addressed to any port or
      #    packets lacking destination port information (for example, UDP fragments
      #    after the first fragment) to be forwarded to the backends configured with
      #    this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.
  &quot;allowGlobalAccess&quot;: True or False, # If set to true, clients can access the internal passthrough Network Load
      # Balancers, the regional internal Application Load Balancer, and the
      # regional internal proxy Network Load Balancer from all regions.
      # If false, only allows access from the local region the load balancer is
      # located at. Note that for INTERNAL_MANAGED forwarding rules, this field
      # cannot be changed after the forwarding rule is created.
  &quot;allowPscGlobalAccess&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether the PSC
      # endpoint can be accessed from another region.
  &quot;backendService&quot;: &quot;A String&quot;, # Identifies the backend service to which the forwarding rule sends traffic.
      # Required for internal and external passthrough Network Load Balancers;
      # must be omitted for all other load balancer types.
  &quot;baseForwardingRule&quot;: &quot;A String&quot;, # [Output Only] The URL for the corresponding base forwarding rule. By base
      # forwarding rule, we mean the forwarding rule that has the same IP address,
      # protocol, and port settings with the current forwarding rule, but without
      # sourceIPRanges specified.
      # Always empty if the current forwarding rule does not have sourceIPRanges
      # specified.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
      # text format.
  &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
      # create the resource.
  &quot;externalManagedBackendBucketMigrationState&quot;: &quot;A String&quot;, # Specifies the canary migration state for the backend buckets attached to
      # this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
      # TEST_ALL_TRAFFIC.
      # 
      # To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be
      # changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before
      # the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the
      # TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets
      # attached to this forwarding rule by percentage using
      # externalManagedBackendBucketMigrationTestingPercentage.
      # 
      # Rolling back a migration requires the states to be set in reverse order. So
      # changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to
      # be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
      # TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
      # EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
  &quot;externalManagedBackendBucketMigrationTestingPercentage&quot;: 3.14, # Determines the fraction of requests to backend buckets that should be
      # processed by the global external Application Load Balancer.
      # 
      # The value of this field must be in the range [0, 100].
      # 
      # This value can only be set if the loadBalancingScheme in the BackendService
      # is set to EXTERNAL (when using the classic Application Load Balancer) and
      # the migration state is TEST_BY_PERCENTAGE.
  &quot;fingerprint&quot;: &quot;A String&quot;, # Fingerprint of this resource. A hash of the contents stored in this object.
      # This field is used in optimistic locking. This field will be ignored when
      # inserting a ForwardingRule. Include the fingerprint in patch request to
      # ensure that you do not overwrite changes that were applied from another
      # concurrent request.
      # 
      # To see the latest fingerprint, make a get() request to
      # retrieve a ForwardingRule.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
      # defined by the server.
  &quot;ipCollection&quot;: &quot;A String&quot;, # Resource reference of a PublicDelegatedPrefix. The PDP must
      # be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
      # 
      # Use one of the following formats to specify a sub-PDP when creating an IPv6
      # NetLB forwarding rule using BYOIP:
      # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
      # Partial URL, as in:
      # 
      #    - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name
      #    - regions/region/publicDelegatedPrefixes/sub-pdp-name
  &quot;ipVersion&quot;: &quot;A String&quot;, # The IP Version that will be used by this forwarding rule.  Valid options
      # are IPV4 or IPV6.
  &quot;isMirroringCollector&quot;: True or False, # Indicates whether or not this load balancer can be used as a collector for
      # packet mirroring. To prevent mirroring loops, instances behind this
      # load balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.
      # This can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.
  &quot;kind&quot;: &quot;compute#forwardingRule&quot;, # [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.
  &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this resource, which is
      # essentially a hash of the labels set used for optimistic locking. The
      # fingerprint is initially generated by Compute Engine and changes after
      # every request to modify or update labels. You must always provide an
      # up-to-date fingerprint hash in order to update or change labels,
      # otherwise the request will fail with error412 conditionNotMet.
      # 
      # To see the latest fingerprint, make a get() request to
      # retrieve a ForwardingRule.
  &quot;labels&quot;: { # Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.
      # Label values may be empty.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;loadBalancingScheme&quot;: &quot;A String&quot;, # Specifies the forwarding rule type.
      # 
      # For more information about forwarding rules, refer to
      # Forwarding rule concepts.
  &quot;metadataFilters&quot;: [ # Opaque filter criteria used by load balancer to restrict routing
      # configuration to a limited set of xDS
      # compliant clients. In their xDS requests to load balancer, xDS clients
      # present node
      # metadata. When there is a match, the relevant configuration
      # is made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)
      # referenced by the ForwardingRule are not visible to
      # those proxies.
      # 
      # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in
      # the metadata. If its filterMatchCriteria is set to
      # MATCH_ALL, then all of its filterLabels must match with
      # corresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied
      # in order to be considered a match.
      # 
      # metadataFilters specified here will be applifed before
      # those specified in the UrlMap that thisForwardingRule references.
      # 
      # metadataFilters only applies to Loadbalancers that have
      # their loadBalancingScheme set toINTERNAL_SELF_MANAGED.
    { # Opaque filter criteria used by load balancers to restrict routing
        # configuration to a limited set of load balancing proxies. Proxies and
        # sidecars involved in load balancing would typically present metadata to the
        # load balancers that need to match criteria specified here. If a match takes
        # place, the relevant configuration is made available to those
        # proxies.
        #
        # For each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least
        # one of thefilterLabels must match the corresponding label provided in
        # the metadata. If its filterMatchCriteria is set to
        # MATCH_ALL, then all of its filterLabels must match with
        # corresponding labels provided in the metadata.
        #
        # An example for using metadataFilters would be: if
        # load balancing involves
        # Envoys, they receive routing configuration when values inmetadataFilters match values supplied in  of their XDS requests to loadbalancers.
      &quot;filterLabels&quot;: [ # The list of label value pairs that must match labels in the provided
          # metadata based on filterMatchCriteria
          #
          # This list must not be empty and can have at the most 64 entries.
        { # MetadataFilter label name value pairs that are expected
            # to match corresponding labels presented as metadata to the load balancer.
          &quot;name&quot;: &quot;A String&quot;, # Name of metadata label.
              #
              #  The name can have a maximum length of 1024 characters and must be at
              # least 1 character long.
          &quot;value&quot;: &quot;A String&quot;, # The value of the label must match the specified value.
              #
              # value can have a maximum length of 1024 characters.
        },
      ],
      &quot;filterMatchCriteria&quot;: &quot;A String&quot;, # Specifies how individual filter label matches
          # within the list of filterLabels and contributes toward the
          # overall metadataFilter match.
          #
          #  Supported values are:
          #
          #    - MATCH_ANY: at least one of the filterLabels
          #    must have a matching label in the provided metadata.
          #    - MATCH_ALL: all filterLabels must have
          #    matching labels in the provided metadata.
    },
  ],
  &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
      # The name must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the name must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must
      # be a dash, lowercase letter, or digit, except the last character, which
      # cannot be a dash.
      # 
      # For Private Service Connect forwarding rules that forward traffic to Google
      # APIs, the forwarding rule name must be a 1-20 characters string with
      # lowercase letters and numbers and must start with a letter.
  &quot;network&quot;: &quot;A String&quot;, # This field is not used for global external load balancing.
      # 
      # For internal passthrough Network Load Balancers, this field identifies the
      # network that the load balanced IP should belong to for this forwarding
      # rule.
      # If the subnetwork is specified, the network of the subnetwork will be used.
      # If neither subnetwork nor this field is specified, the default network will
      # be used.
      # 
      # For Private Service Connect forwarding rules that forward traffic to Google
      # APIs, a network must be provided.
  &quot;networkTier&quot;: &quot;A String&quot;, # This signifies the networking tier used for configuring
      # this load balancer and can only take the following values:PREMIUM, STANDARD.
      # 
      # For regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.
      # 
      # If this field is not specified, it is assumed to be PREMIUM.
      # If IPAddress is specified, this value must be equal to the
      # networkTier of the Address.
  &quot;noAutomateDnsZone&quot;: True or False, # This is used in PSC consumer ForwardingRule to control whether it should
      # try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use
      # this field. Once set, this field is not mutable.
  &quot;portRange&quot;: &quot;A String&quot;, # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      # 
      # The portRange field has the following limitations:
      # 
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, or SCTP, and
      #    - It&#x27;s applicable only to the following products: external passthrough
      #    Network Load Balancers, internal and external proxy Network Load Balancers,
      #    internal and external Application Load Balancers, external protocol
      #    forwarding, and Classic VPN.
      #    - Some products have restrictions on what ports can be used. See
      #    port specifications for details.
      # 
      # 
      # 
      # For external forwarding rules, two or more forwarding rules cannot use the
      # same [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.
      # 
      # For internal forwarding rules within the same VPC network, two or more
      # forwarding rules cannot use the same [IPAddress, IPProtocol]
      # pair, and cannot have overlapping portRanges.
      # 
      # @pattern: \\d+(?:-\\d+)?
  &quot;ports&quot;: [ # The ports, portRange, and allPorts
      # fields are mutually exclusive. Only packets addressed to ports in the
      # specified range will be forwarded to the backends configured with this
      # forwarding rule.
      # 
      # The ports field has the following limitations:
      # 
      #    - It requires that the forwarding rule IPProtocol be TCP,
      #    UDP, or SCTP, and
      #    - It&#x27;s applicable only to the following products: internal passthrough
      #    Network Load Balancers, backend service-based external passthrough Network
      #    Load Balancers, and internal protocol forwarding.
      #    - You can specify a list of up to five ports by number, separated by
      #    commas. The ports can be contiguous or discontiguous.
      # 
      # 
      # 
      # For external forwarding rules, two or more forwarding rules cannot use the
      # same [IPAddress, IPProtocol] pair if they share at least one
      # port number.
      # 
      # For internal forwarding rules within the same VPC network, two or more
      # forwarding rules cannot use the same [IPAddress, IPProtocol]
      # pair if they share at least one port number.
      # 
      # @pattern: \\d+(?:-\\d+)?
    &quot;A String&quot;,
  ],
  &quot;pscConnectionId&quot;: &quot;A String&quot;, # [Output Only] The PSC connection id of the PSC forwarding rule.
  &quot;pscConnectionStatus&quot;: &quot;A String&quot;,
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional forwarding rule resides.
      # This field is not applicable to global forwarding rules.
      # You must specify this field as part of the HTTP request URL. It is
      # not settable as a field in the request body.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
  &quot;serviceDirectoryRegistrations&quot;: [ # Service Directory resources to register this forwarding rule with.
      # Currently, only supports a single Service Directory resource.
    { # Describes the auto-registration of the forwarding rule to Service Directory.
        # The region and project of the Service Directory resource generated from
        # this registration will be the same as this forwarding rule.
      &quot;namespace&quot;: &quot;A String&quot;, # Service Directory namespace to register the forwarding rule under.
      &quot;service&quot;: &quot;A String&quot;, # Service Directory service to register the forwarding rule under.
      &quot;serviceDirectoryRegion&quot;: &quot;A String&quot;, # [Optional] Service Directory region to register this global forwarding
          # rule under. Default to &quot;us-central1&quot;. Only used for PSC for Google APIs.
          # All PSC for Google APIs forwarding rules on the same network should use
          # the same Service Directory region.
    },
  ],
  &quot;serviceLabel&quot;: &quot;A String&quot;, # An optional prefix to the service name for this forwarding rule.
      # If specified, the prefix is the first label of the fully qualified service
      # name.
      # 
      # The label must be 1-63 characters long, and comply withRFC1035.
      # Specifically, the label must be 1-63 characters long and match the regular
      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      # character must be a lowercase letter, and all following characters must
      # be a dash, lowercase letter, or digit, except the last character, which
      # cannot be a dash.
      # 
      # This field is only used for internal load balancing.
  &quot;serviceName&quot;: &quot;A String&quot;, # [Output Only]
      # The internal fully qualified service name for this forwarding rule.
      # 
      # This field is only used for internal load balancing.
  &quot;sourceIpRanges&quot;: [ # If not empty, this forwarding rule will only forward the traffic when the
      # source IP address matches one of the IP addresses or CIDR ranges set here.
      # Note that a forwarding rule can only have up to 64 source IP ranges, and
      # this field can only be used with a regional forwarding rule whose scheme isEXTERNAL.
      # Each source_ip_range entry should be either an IP address (for
      # example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
    &quot;A String&quot;,
  ],
  &quot;subnetwork&quot;: &quot;A String&quot;, # This field identifies the subnetwork that the load balanced IP should
      # belong to for this forwarding rule, used with internal load balancers and
      # external passthrough Network Load Balancers with IPv6.
      # 
      # If the network specified is in auto subnet mode, this field is optional.
      # However, a subnetwork must be specified if the network is in custom subnet
      # mode or when creating external forwarding rule with IPv6.
  &quot;target&quot;: &quot;A String&quot;, # The URL of the target resource to receive the matched traffic.  For
      # regional forwarding rules, this target must be in the same region as the
      # forwarding rule. For global forwarding rules, this target must be a global
      # load balancing resource.
      # 
      # The forwarded traffic must be of a type appropriate to the target object.
      # 
      # 
      #      -  For load balancers, see the &quot;Target&quot; column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).
      #      -  For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
      # 
      # 
      #             -  vpc-sc -  APIs that support VPC Service Controls.
      #             -  all-apis - All supported Google APIs.
      # 
      # 
      #      -  For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.
}

  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.

For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.

The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

<div class="method">
    <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code>
  <pre>Sets the labels on the specified resource. To learn more about labels,
read the 
Labeling Resources documentation.

Args:
  project: string, Project ID for this request. (required)
  region: string, The region for this request. (required)
  resource: string, Name or id of the resource for this request. (required)
  body: object, The request body.
    The object takes the form of:

{
  &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
      # used to detect conflicts. The fingerprint is initially generated by Compute
      # Engine and changes after every request to modify or update labels. You must
      # always provide an up-to-date fingerprint hash in order to update or change
      # labels. Make a get() request to the resource to get the latest
      # fingerprint.
  &quot;labels&quot;: { # The labels to set for this resource.
    &quot;a_key&quot;: &quot;A String&quot;,
  },
}

  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.

For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.

The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

<div class="method">
    <code class="details" id="setTarget">setTarget(project, region, forwardingRule, body=None, requestId=None, x__xgafv=None)</code>
  <pre>Changes target URL for forwarding rule. The new target should be of the
same type as the old target.

Args:
  project: string, Project ID for this request. (required)
  region: string, Name of the region scoping this request. (required)
  forwardingRule: string, Name of the ForwardingRule resource in which target is to be set. (required)
  body: object, The request body.
    The object takes the form of:

{
  &quot;target&quot;: &quot;A String&quot;,
}

  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
that if you must retry your request, the server will know to ignore the
request if it has already been completed.

For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request. This
prevents clients from accidentally creating duplicate commitments.

The request ID must be
a valid UUID with the exception that zero UUID is not supported
(00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an Operation resource.
    #
    # Google Compute Engine has three Operation resources:
    #
    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
    #
    # You can use an operation resource to manage asynchronous API requests.
    # For more information, readHandling
    # API responses.
    #
    # Operations can be global, regional or zonal.
    #
    #    - For global operations, use the `globalOperations`
    #    resource.
    #    - For regional operations, use the
    #    `regionOperations` resource.
    #    - For zonal operations, use
    #    the `zoneOperations` resource.
    #
    #
    #
    # For more information, read
    # Global, Regional, and Zonal Resources.
    #
    # Note that completed Operation resources have a limited
    # retention period.
  &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
      # Not present otherwise.
  &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
  &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
      # set when the operation is created.
  &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
      # text format.
  &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
      # this field will be populated.
    &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
        # operation.
      {
        &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
        &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
            # details. There is a set of defined message types to use for providing
            # details.The syntax depends on the error code. For example,
            # QuotaExceededInfo will have details when the error code is
            # QUOTA_EXCEEDED.
          {
            &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
                #
                # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
                # is not enabled:
                #
                #     { &quot;reason&quot;: &quot;API_DISABLED&quot;
                #       &quot;domain&quot;: &quot;googleapis.com&quot;
                #       &quot;metadata&quot;: {
                #         &quot;resource&quot;: &quot;projects/123&quot;,
                #         &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
                #       }
                #     }
                #
                # This response indicates that the pubsub.googleapis.com API is not enabled.
                #
                # Example of an error that is returned when attempting to create a Spanner
                # instance in a region that is out of stock:
                #
                #     { &quot;reason&quot;: &quot;STOCKOUT&quot;
                #       &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
                #       &quot;metadata&quot;: {
                #         &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
                #       }
                #     }
              &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
                  # is typically the registered service name of the tool or product that
                  # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
                  # generated by some common infrastructure, the error domain must be a
                  # globally unique value that identifies the infrastructure. For Google API
                  # infrastructure, the error domain is &quot;googleapis.com&quot;.
              &quot;metadatas&quot;: { # Additional structured details about this error.
                  #
                  # Keys must match a regular expression of `a-z+` but should
                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
                  # length. When identifying the current value of an exceeded limit, the units
                  # should be contained in the key, not the value.  For example, rather than
                  # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
                  # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
                  # instances that can be created in a single (batch) request.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
                  # proximate cause of the error. Error reasons are unique within a particular
                  # domain of errors. This should be at most 63 characters and match a
                  # regular expression of `A-Z+[A-Z0-9]`, which represents
                  # UPPER_SNAKE_CASE.
            },
            &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
                #
                # For example, if a quota check failed with an error indicating the calling
                # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
                # directly to the right place in the developer console to flip the bit.
              &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
                { # Describes a URL link.
                  &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
                  &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
                },
              ],
            },
            &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
                # which can be attached to an RPC error.
              &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
                  # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
              &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
            },
            &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
              &quot;dimensions&quot;: { # The map holding related quota dimensions.
                &quot;a_key&quot;: &quot;A String&quot;,
              },
              &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
                  #  type or metric.
              &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
                  # or metric.
              &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
              &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
              &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
            },
          },
        ],
        &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
            # This property is optional.
        &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
      },
    ],
  },
  &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
      # message that was returned, such as `NOT FOUND`.
  &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
      # status code that was returned. For example, a `404` means the
      # resource was not found.
  &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
      # defined by the server.
  &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
      # This value is inRFC3339
      # text format.
  &quot;instancesBulkInsertOperationMetadata&quot;: {
    &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
        &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
        &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
            # error.
        &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
            # if the flow is rolling forward or rolling back.
        &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
      },
    },
  },
  &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for
      # Operation resources.
  &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
  &quot;operationGroupId&quot;: &quot;A String&quot;, # [Output Only] An ID that represents a group of operations, such as when a
      # group of operations results from a `bulkInsert` API request.
  &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
      # `update`, or `delete`, and so on.
  &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
      # There is no requirement that this be linear or support any granularity of
      # operations. This should not be used to guess when the operation will be
      # complete. This number should monotonically increase as the operation
      # progresses.
  &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
      # applicable when performing regional operations.
  &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
  &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
      # this field will contain information on all underlying zonal actions and
      # their state.
    &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
    &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
        # Example key: zones/us-central1-a
      &quot;a_key&quot;: {
        &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
            # populated.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
          &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
              # message types for APIs to use.
            {
              &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
            },
          ],
          &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
        },
        &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
      },
    },
  },
  &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
      # This value is inRFC3339
      # text format.
  &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
      # following:
      # `PENDING`, `RUNNING`, or `DONE`.
  &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
      # operation.
  &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
      # of the target resource.
  &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
      # operations related to creating a snapshot, this points to the disk
      # that the snapshot was created from.
  &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
      # `user@example.com` or
      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
  &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
      # operation, this field will be populated.
    {
      &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
          # Engine returns NO_RESULTS_ON_PAGE if there
          # are no results in the response.
      &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
          # value format. For example:
          #
          # &quot;data&quot;: [
          #   {
          #    &quot;key&quot;: &quot;scope&quot;,
          #    &quot;value&quot;: &quot;zones/us-east1-d&quot;
          #   }
        {
          &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
              # returned. For example, for warnings where there are no results in a list
              # request for a particular zone, this key might be scope and
              # the key value might be the zone name. Other examples might be a key
              # indicating a deprecated resource and a suggested replacement, or a
              # warning about invalid network settings (for example, if an instance
              # attempts to perform IP forwarding but is not enabled for IP forwarding).
          &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
    },
  ],
  &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
      # applicable when performing per-zone operations.
}</pre>
</div>

</body></html>